home *** CD-ROM | disk | FTP | other *** search
/ TPUG - Toronto PET Users Group / TPUG Users Group CD / TPUG Users Group CD.iso / AMIGA / AMICUS / AMICUS08.ADF / Progs / AmigaSpell.DOC < prev    next >
Text File  |  1986-04-02  |  7KB  |  150 lines
  1. AmigaSpell Documentation - 27 Mar 86
  2. ====================================
  3.  
  4. (C) 1986 by Mike Berro [73267,3361]
  5.             BCS Software
  6.             13432 Lochrin Lane
  7.             Sylmar, CA  91342
  8.  
  9. AmigaSpell is for the use of CompuServe subscribers and friends. Back it up,
  10. give it away, but do not sell it or post it onto any BBS.  Thanx!
  11.  
  12. Please note that the Beta Test Version allows a maximum of 3000 words in the
  13. glossary.  The final version will allow about 35,000 on a 512K machine.
  14.  
  15.  
  16. Acknowledgements
  17. ----------------
  18.  
  19. I would like to thank David Haynie, Bruce Bowen, Rob Peck (for "simple"),
  20. Larry Philips, Scott Ballantyne, Amiga Engineering, and everyone else in
  21. the AmigaForum who contributed directly or indirectly to this program.
  22.  
  23. This program is not based on any other spelling program, because I have
  24. never had the privilege of seeing one.  If you have any suggestions, please
  25. leave me a message on Compuserve.  I will also be happy to answer any
  26. questions about the program.
  27.  
  28.  
  29. Features
  30. --------
  31.  
  32. * Use it from Workbench or CLI.  Optional extended selection lets you avoid
  33.   having to type in the filename.
  34. * Analyze a file or an individual word.
  35. * Finds the closest word using a custom string compare function (the only
  36.   original function in the program).
  37. * Prints a list of mis-spelled words and closest word.
  38. * Prints the entire glossary - 500 words per page.
  39. * Analyzes ALL files - text, binary, MBS, data.
  40. * Allows you to add words that it finds but does not know.
  41. * The glossary file is a standard text file that you can examine and modify.
  42.  
  43.  
  44. How to Use It
  45. -------------
  46.  
  47. From the Workbench, activate AmigaSpell by moving the pointer over the icon
  48. and then press the left mouse button twice quickly.  You can skip a few
  49. steps by using extended selection to select a single file for analyzing (see
  50. below).
  51.  
  52. From CLI, just type "Run AmigaSpell".  You can skip a few steps by typing the
  53. filename to be analyzed after it on the same line.  If so, the program will
  54. proceed directly to ANALYZE A FILE, described below.
  55.  
  56. The AmigaSpell Window will appear, and then the copyright notice.  At the
  57. bottom of the screen the number of words in the glossary will be
  58. displayed.  If the glossary file is not on the disk, AmigaSpell will
  59. create one that contains two words, AMIGA and SPELL.  This file is called
  60. "AmigaSpell.data".
  61.  
  62. You are then prompted to make a selection from the menu.  There are five
  63. items on the menu, ANALYZE A FILE, ANALYZE A WORD, SORT THE GLOSSARY,
  64. PRINT THE GLOSSARY, and QUIT.  Selecting quit does the same thing as
  65. selecting the close gadget in the upper-left corner of the window.  All files
  66. are closed, all memory used by the program is freed, and the window is
  67. closed.  You may close the window any time the program is requesting an
  68. input from you.
  69.  
  70. Please note that any time you are asked for an input, you may also make a
  71. selection from the menu.  "Escape" or "Done" will save the new dictionary
  72. words (if any), "Abort" will return directly to the copyright notice.
  73.  
  74.  
  75. ANALYZE A FILE
  76. --------------
  77.  
  78. Selecting this function causes the program to check the file you enter from
  79. the keyboard for spelling errors.  If you have already selected a file from
  80. Workbench or CLI, you will not have to type in the filename.  If not, you
  81. must enter the filename from the keyboard.  Press the ESC key (or select it
  82. from the menu) to return to the copyright notice.
  83.  
  84. While the program analyzes the file, each word is displayed in white, and
  85. the words "found" or "not found" will follow as approriate.  A 15K file may
  86. take up to two minutes to analyze, so you can do other tasks while it is
  87. working.  Please note that a 1500 word glossary uses 30K of memory, which
  88. is not released until the file is completely analyzed.
  89.  
  90. When the program has finished analyzing the file, it will present each word
  91. it has not found one at a time, as well as the word that comes closest to it
  92. in the glossary (it is not necessary for the glossary to be sorted for
  93. this to occur).  It will present the word only once, even if the word occurs
  94. several times in the file.   The program will then inquire if you want to
  95. add the word to the glossary.  If you do just press "y", otherwise press
  96. "n".  If you make a mistake, you can go back to the previous word by
  97. pressing the BACK SPACE key.  You can press the ESC key to abort.  AmigaSpell
  98. will continue in this manner until all the unmatched words are accounted for.
  99. If you have added words to the glossary, the glossary will then be saved
  100. onto the disk.
  101.  
  102. You are then asked if you would like a printout of all unmatched words that
  103. were not added to the glossary.  Presumably these are the misspelled
  104. words.  If you press "y", you will get a printout of each unmatched word and
  105. the closest word found.  If you press "n" the program will return to the
  106. copyright notice, unless you have specified a file from Workbench or CLI.
  107. In that case the program will end, and the window will close.
  108.  
  109.  
  110. ANALYZE A WORD
  111. --------------
  112.  
  113. This function works the same as ANALYZE A FILE, except that you enter each
  114. word from the keyboard.  To exit this function, press RETURN instead of
  115. entering a word, or select DONE from the menu.
  116.  
  117. If you exit when you are being requested for a word, any words you have
  118. added to the glossary will be saved on the disk, and you can print out the
  119. words you have not added (if any).  If you select ABORT from the menu when
  120. you are being asked whether or not to add a word, you will return
  121. immediately to the copyright notice.
  122.  
  123.  
  124. SORT THE GLOSSARY
  125. -----------------
  126.  
  127. This function simply sorts the words in the file "AmigaSpell.data".  It does
  128. this by creating a file called "AmigaSpell.data.temp", so make sure you have
  129. room on the disk for this temporary file.  The temporary file is deleted at
  130. the end of the sort process.
  131.  
  132.  
  133. PRINT THE GLOSSARY
  134. ------------------
  135.  
  136. This function prints the file "AmigaSpell.data".  The program tries to fit
  137. as many words as possible on a single line (separated by a single space) in
  138. order to conserve paper.
  139.  
  140.  
  141. Adding and Deleting Words
  142. -------------------------
  143.  
  144. You can add and delete words by editing the file "AmigaSpell.data" using "ed"
  145. from the CLI or TextCraft(tm).  If you use TextCraft, make sure you save the
  146. file as a "text only" file.  Also, make sure every word you add is in upper
  147. case, or AmigaSpell will ignore it.  AmigaSpell also ignores words shorter
  148. the 3 or longer than 18 letters.
  149.  
  150.